| Name | Description | |
|---|---|---|
 | PDFStructureElement Constructor | Overloaded. |
PDFStructureElement Class Members
In This Topic
The following tables list the members exposed by PDFStructureElement.
Public Constructors
Public Methods
| Name | Description | |
|---|---|---|
 | appendChild | Adds a new child to this structure element. |
| getActualText | Gets the actual text of the structure element. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes. |
| getAlternateDescription | Gets the alternate description of the structure element. |
| getAttributes | Gets the attributes of the structure element. |
| getChildren | Gets the content of this structure element. <br> The value of this entry may be one of the following objects or a collection consisting of one or more of the following objects in any combination:<br> • Another structure element<br> • An integer marked-content identifier (<see cref="559f8e0c-ae20-410f-b587-36cf1bf7eeb3" info="T:com.o2sol.pdf4java.logicalstructure.PDFMarkedContentSequenceIdentifier" />) denoting a marked-content sequence<br> • A marked-content reference (<see cref="7126fde5-3233-4dc4-8e30-4469b5044efb" info="T:com.o2sol.pdf4java.logicalstructure.PDFMarkedContentReference" />) denoting a marked-content sequence<br> • An object reference (<see cref="598cd301-a112-49f2-ad66-9be6b8186747" info="T:com.o2sol.pdf4java.logicalstructure.PDFObjectReference" />) denoting a PDF object<br> Each of these objects other than the first (the structure element) shall be considered to be a content item. |
| getClassNames | Gets the attributes class names. |
| getCosContent | Gets the COS structure element. |
| getCosStructureElement | Gets the COS structure element. |
| getExpandedForm | Gets the expanded form of an abbreviation. |
| getGenerateMarkedContentSequence | Gets a flag indicating whether this structure element will be associated with a marked content sequence. This property is used only with formatted content and flow documents, to inform the layout engine whether to generate a marked content sequence or not for an object in the hierarchy. The method ignores the value of this property. |
| getID | Gets the ID of this structure element. The string shall be unique among all elements in the document's structure hierarchy. |
| getLanguage | Gets the language of the structure element. |
| getPage | Gets the PDF page that contains the content of this structure element. |
| getParent | Gets the parent of this structure element. |
| getPhoneme | Gets the phoneme of the structure element. It is an exact replacement for content enclosed by the structure element and its children. The value for this property is to be interpreted based on the property in effect. |
| getPhoneticAlphabet | Gets the phonetic alphabet of the structure element. <br> This property applies to the structure element and its children, except where overridden by a child structure element.<br> Currently defined values are:<br> • <b>ipa</b> for the International Phonetic Alphabet by the International Phonetic Association<br> • <b>x-sampa</b> for Extended Speech Assessment Methods Phonetic Alphabet(X-SAMPA)<br> • <b>zh-Latn-pinyin</b> for Pinyin Latin romanization(Mandarin)<br> • <b>zh-Latn-wadegile</b> for Wade-Giles romanization(Mandarin) |
| getReferences | Gets the list of references. This property identifies the structure element or elements to which the item of content, contained within this structure element, refers (e.g.footnotes, end notes, sidebars, etc.). |
| getRevision | Gets the revision of this structure element. |
| getTitle | Gets the title of the structure element. The title should characterise the specific structure element, such as Chapter 1, rather than merely a generic element type, such as Chapter. |
| getType | Gets the type of the structure element. Names of structure element types shall conform to the guidelines described in Annex E, "PDF Name Registry", of PDF specification. A set of standard structure types is defined as constants in class. |
| setActualText | Sets the actual text of the structure element. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes. |
| setAlternateDescription | Sets the alternate description of the structure element. |
| setAttributes | Sets the attributes of the structure element. |
| setChildren | Sets the content of this structure element. <br> The value of this entry may be one of the following objects or a collection consisting of one or more of the following objects in any combination:<br> • Another structure element<br> • An integer marked-content identifier (<see cref="559f8e0c-ae20-410f-b587-36cf1bf7eeb3" info="T:com.o2sol.pdf4java.logicalstructure.PDFMarkedContentSequenceIdentifier" />) denoting a marked-content sequence<br> • A marked-content reference (<see cref="7126fde5-3233-4dc4-8e30-4469b5044efb" info="T:com.o2sol.pdf4java.logicalstructure.PDFMarkedContentReference" />) denoting a marked-content sequence<br> • An object reference (<see cref="598cd301-a112-49f2-ad66-9be6b8186747" info="T:com.o2sol.pdf4java.logicalstructure.PDFObjectReference" />) denoting a PDF object<br> Each of these objects other than the first (the structure element) shall be considered to be a content item. |
| setClassNames | Sets the attributes class names. |
| setExpandedForm | Sets the expanded form of an abbreviation. |
| setGenerateMarkedContentSequence | Sets a flag indicating whether this structure element will be associated with a marked content sequence. This property is used only with formatted content and flow documents, to inform the layout engine whether to generate a marked content sequence or not for an object in the hierarchy. The method ignores the value of this property. |
| setID | Sets the ID of this structure element. The string shall be unique among all elements in the document's structure hierarchy. |
| setLanguage | Sets the language of the structure element. |
| setPage | Sets the PDF page that contains the content of this structure element. |
| setPhoneme | Sets the phoneme of the structure element. It is an exact replacement for content enclosed by the structure element and its children. The value for this property is to be interpreted based on the property in effect. |
| setPhoneticAlphabet | Sets the phonetic alphabet of the structure element. <br> This property applies to the structure element and its children, except where overridden by a child structure element.<br> Currently defined values are:<br> • <b>ipa</b> for the International Phonetic Alphabet by the International Phonetic Association<br> • <b>x-sampa</b> for Extended Speech Assessment Methods Phonetic Alphabet(X-SAMPA)<br> • <b>zh-Latn-pinyin</b> for Pinyin Latin romanization(Mandarin)<br> • <b>zh-Latn-wadegile</b> for Wade-Giles romanization(Mandarin) |
| setReferences | Sets the list of references. This property identifies the structure element or elements to which the item of content, contained within this structure element, refers (e.g.footnotes, end notes, sidebars, etc.). |
| setRevision | Sets the revision of this structure element. |
| setTitle | Sets the title of the structure element. The title should characterise the specific structure element, such as Chapter 1, rather than merely a generic element type, such as Chapter. |
| setType | Sets the type of the structure element. Names of structure element types shall conform to the guidelines described in Annex E, "PDF Name Registry", of PDF specification. A set of standard structure types is defined as constants in class. |
See Also